home *** CD-ROM | disk | FTP | other *** search
/ Business Shareware / Business Shareware.iso / start / disk / dxp21a / dxp.doc next >
Text File  |  1993-02-11  |  44KB  |  1,255 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                                                             Disk eXPress
  9.  
  10.                                                             for Creating
  11.                                                          Diskette Images
  12.  
  13.                                                                      DXP
  14.                                                            Version 2.10a
  15.                                                                 02/12/93
  16.  
  17.  
  18.  
  19.                                   TABLE OF CONTENTS
  20.        _________________________________________________________________
  21.  
  22.             1.0. INTRODUCTION TO Disk eXPress ........................3
  23.                  1.1. What is Disk eXPress? ..........................3
  24.                  1.2. Features of Disk eXPress .......................3
  25.                  1.3. New features in Disk eXPress Version 2 .........4
  26.                  1.4. New Disk eXPress companion program: Xtract .....4
  27.                  1.5. What's new in Version 2.10a ....................5
  28.             2.0. SYSTEM REQUIREMENTS .................................5
  29.             3.0. COPYRIGHT NOTICE ....................................5
  30.             4.0. WARRANTY ............................................6
  31.             5.0. COST OF Disk eXPress ................................6
  32.             6.0. CONTENTS OF THIS PACKAGE ............................6
  33.             7.0. SYNTAX ..............................................7
  34.                  7.1. Quick start ....................................7
  35.                  7.2. Disk eXPress help screens ......................9
  36.             8.0. COMMAND LINE SWITCHES DESCRIPTION ...................11
  37.                  8.1. Regular mode ...................................11
  38.                  8.2. Extract mode ...................................12
  39.                  8.3. Batch mode support .............................13
  40.                  8.4. Disk eXPress real-time bar graph display .......14
  41.             9.0. EXAMPLES ............................................15
  42.                  9.1. Example 1 ......................................15
  43.                  9.2. Example 2 ......................................16
  44.                  9.3. Example 3 ......................................16
  45.                  9.4. Example 4 ......................................17
  46.                  9.5. Example 5 ......................................17
  47.                  9.6. Example 6 ......................................18
  48.                  9.7. Example 7 ......................................18
  49.                  9.8. Example 8 ......................................19
  50.             10.0. ERROR MESSAGES .....................................20
  51.             11.0. LIMITATIONS ........................................22
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.                                                                        2
  75.  
  76.  
  77.  
  78.        1.0. INTRODUCTION TO Disk eXPress
  79.        _________________________________________________________________
  80.  
  81.        1.1. What is Disk eXPress?
  82.  
  83.        Disk eXPress (DXP) allows a diskette image to be created for
  84.        electronic transmission.  Think of it as a way for preparing a
  85.        diskette to be FAXed like a regular document.  Once the diskette
  86.        image is created, it can be transmitted with the use of a modem
  87.        on a regular phone line, or any other electronic networks.
  88.  
  89.        One area of use is to archive diskette images on hard drives or
  90.        tapes.  This can be useful for companies maintaining an
  91.        electronic bulletin board service for clients, in which diskette
  92.        images for the latest hardware drivers, or fixes are available
  93.        for download.  This guarantees the contents of the diskette to be
  94.        the same as the original -- including all directory structures,
  95.        date and time stamps of all the files and directories, and the
  96.        location of any hidden information.
  97.  
  98.        For simple file archival purpose, the use of Disk eXPress should
  99.        be avoided.  The user is encouraged to use one of the many fine
  100.        archive programs available on the market.  Disk eXPress is useful
  101.        for archiving bootable diskettes, diskettes containing hidden
  102.        information, or files and directory entries containing characters
  103.        unrecognizable by the usual file system functions.  Unlike a file
  104.        archive program, Disk eXPress requires a diskette drive and a
  105.        diskette in order to restore any information stored in an image.
  106.  
  107.  
  108.        1.2. Features of Disk eXPress
  109.  
  110.        -  Disk eXPress recognizes all standard DOS formatted diskettes,
  111.           this includes 160K, 180K, 320K, 360K, 720K, 1.2M, 1.44M, and
  112.           the latest 2.88M diskettes.  Any internal or external diskette
  113.           drives connected via DOS or OS/2 block device drivers are
  114.           recognized (ie: diskette drives accessed via DRIVER.SYS,
  115.           $FDD5.SYS, etc.)  All information on the diskette is saved to
  116.           a file for electronic transmission, no information is lost!
  117.           (see /a switch for detail).
  118.        -  Disk eXPress can be used for diskette conversion.  For
  119.           example, a 360K diskette image can be restored onto a 720K,
  120.           1.44M, or 2.88M diskette.  If someone sends you a bootable
  121.           360K diskette image, you can restore it onto a 720K diskette,
  122.           and the resulting diskette will be bootable.
  123.        -  Advanced virus protection.  Disk eXPress detects illegal
  124.           program modifications whether it's by virus, or bad electronic
  125.           transmissions.
  126.        -  Multiple 32-bit CRC data protection.  The image is protected
  127.           by several 32-bit CRCs.  In some cases, if a non-critical part
  128.           of the image is modified, the resulting diskette will still be
  129.           usable.
  130.  
  131.  
  132.  
  133.                                                                        3
  134.  
  135.  
  136.  
  137.        -  Upgradability of the self-extract code.  Disk eXPress provides
  138.           a means to upgrade the self-extract code within the image file
  139.           for bug fixes, and future code enhancements upgrade.
  140.  
  141.  
  142.        1.3. New features in Disk eXPress Version 2
  143.  
  144.        -  Disk eXPress is now a dual mode executable file.  It runs
  145.           under both OS/2 and DOS.  There is only one version of the
  146.           executable as opposed to two in the previous release.
  147.        -  Disk eXPress exploits the multi-threading capability when it
  148.           is run under OS/2.  It performs simultaneous disk I/O and data
  149.           compression.  This typically gives 10 to 50% speed up compare
  150.           to running it under DOS.
  151.        -  Disk eXPress supports long filename for diskette images
  152.           created under OS/2 with HPFS (High Performance File System)
  153.           disk partition.
  154.        -  New data compression algorithm based on a modified Lempel-Ziv-
  155.           Huffman method.  Disk eXPress now compresses smaller than
  156.           version 1, and is also 2 to 3 times faster.  The compression
  157.           rate is comparable to most file archive programs.  Compression
  158.           is dynamic -- non-compressible data is simply stored.
  159.        -  Real-time bar graph display showing current compression rate,
  160.           disk read/write and compression activities (this capability is
  161.           limited under DOS).
  162.        -  Self-extracting diskette image is also a dual mode executable.
  163.           /DOS and /OS2 switches are no longer required (please refer to
  164.           version 1 documentation).  All the extra functions are
  165.           removed, and are now built-into the extract mode of Disk
  166.           eXPress itself.
  167.        -  Disk eXPress can now create non-self-extract image (pure image
  168.           data).  This is useful for diskette archival purpose on hard
  169.           drive or tape.
  170.        -  Diskette decompression code is now built-into Disk eXPress.
  171.           This can be used to decompress version 2 pure diskette image
  172.           or Disk eXPress version 1 and 2 self-extract images.  It has
  173.           the full set of options, including diskette formatting,
  174.           conversion, and verification.  The decompressor is also fully
  175.           multi-threaded under OS/2 to yield the fastest diskette
  176.           extraction time.
  177.        -  The /t switch is added to all the decompressors so that the
  178.           integrity of the image can be tested before committing the
  179.           lengthy diskette write process.
  180.  
  181.  
  182.        1.4. New Disk eXPress companion program: Xtract
  183.  
  184.        -  Xtract is a dual mode executable.  It features all the
  185.           decompression capability of Disk eXPress, including multi-
  186.           threading under OS/2.
  187.        -  It is used for distributing pure diskette images in which
  188.           unlimited distribution right is granted for Xtract after
  189.           purchasing a licensed copy of Disk eXPress.
  190.  
  191.  
  192.                                                                        4
  193.  
  194.  
  195.  
  196.        -  Xtract is included in the licensed version of Disk eXPress
  197.           (not included in the shareware version).
  198.  
  199.  
  200.        1.5. What's new in Version 2.10a
  201.  
  202.        -  New /q switch for QuickFormatting diskette.
  203.        -  New /DOS switch to create self-extract images that run under
  204.           DOS and OS/2 DOS box ONLY.  Reduction of 13K overhead in self-
  205.           extract code.
  206.        -  New /s switch in self-extract image to bypass warning prompt.
  207.        -  Code and compiler optimizations to reduce self-extract code
  208.           size by 2K and at the same time, achieve a 10% overall speed
  209.           up.
  210.        -  Description can now be entered via environment variables
  211.           (DXPDESC1 to DXPDESC5).
  212.        -  Low level diskette access code has been completely rewritten
  213.           for the DOS side to allow full functionality of Disk eXPress
  214.           under OS/2 DOS box.
  215.        -  Prompt for additional selections ("Format once" and "Format
  216.           all") when a diskette write error is encountered.  This allows
  217.           formatting of just the current track or all subsequent tracks
  218.           before diskette writes.
  219.        -  For a list of bug fixes, please refer to the history file
  220.           (DXP.HST).
  221.  
  222.  
  223.        2.0. SYSTEM REQUIREMENTS
  224.        _________________________________________________________________
  225.  
  226.        IBM PC, PC-AT, PS/1, PS/2 and 100% compatibles.  Minimum 256K
  227.        conventional memory.  MS-DOS or PC-DOS version 3.20 or above;
  228.        OS/2 1.2 or above, including OS/2 Version 2.x, is required.  Hard
  229.        disk is required for storing large image file.  User must also
  230.        provide the necessary program(s) for sending diskette image files
  231.        through telephone network with the use of a modem, and whatever
  232.        is necessary with any other electronic networks.
  233.  
  234.  
  235.        3.0. COPYRIGHT NOTICE
  236.        _________________________________________________________________
  237.  
  238.        DXP (Disk eXPress)  Version 2.10a  02/12/93
  239.        XTRACT (Xtract)     Version 2.10a  02/12/93
  240.        Copyright (c) 1991-93 by
  241.        Albert J. Shan
  242.  
  243.        All Rights Reserved.  No part of this program may be
  244.        disassembled, modified or altered by any means.
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.                                                                        5
  252.  
  253.  
  254.  
  255.        4.0. WARRANTY
  256.        _________________________________________________________________
  257.  
  258.        I, Albert J. Shan, make no warranties, expressed or implied,
  259.        including, but not limited to, merchantability or fitness for any
  260.        particular purpose.  In no event shall Albert J. Shan be liable
  261.        for indirect or consequential damages arising from the use of the
  262.        software program.
  263.  
  264.        You are free to redistribute this shareware package in its
  265.        entirety.  No part of this package may be included as part of a
  266.        commercial package.  If you have any questions about commercial
  267.        distribution of Disk eXPress, I can be contacted at:
  268.  
  269.        Albert J. Shan
  270.        866 Citadel Drive
  271.        Port Coquitlam, British Columbia
  272.        CANADA  V3C 5Y1
  273.  
  274.        or via CompuServe, ID 70730,401
  275.  
  276.  
  277.        5.0. COST OF Disk eXPress
  278.        _________________________________________________________________
  279.  
  280.        Disk eXPress Version 1 was labeled as "beggarware" in which user
  281.        is not required to pay a fee.  Due to all the effort and time I
  282.        put in for Version 2, it is now marketed as shareware.  The user
  283.        is granted a 30 days trial period, after which he or she is
  284.        required to register the product.  The cost of a single machine
  285.        license is $24 Canadian.  Unlimited distribution right of Xtract
  286.        is granted upon licensing Disk eXPress.  Please refer to the file
  287.        ORDER.FRM for details.
  288.  
  289.  
  290.        6.0. CONTENTS OF THIS PACKAGE
  291.        _________________________________________________________________
  292.  
  293.        The following files are included in this package:
  294.  
  295.            DXP.EXE    - Disk eXPress executable
  296.            DXP.DOC    - This documentation
  297.            DXP.HST    - History file
  298.            ORDER.FRM  - Order form
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.                                                                        6
  311.  
  312.  
  313.  
  314.        7.0. SYNTAX
  315.        _________________________________________________________________
  316.  
  317.        7.1. Quick start
  318.  
  319.        The syntax of Disk eXPress is very similar to the COPY command.
  320.        To create a diskette image, type:
  321.  
  322.          dxp drive: filename
  323.  
  324.        To create a diskette from an image file, type:
  325.  
  326.          dxp filename drive:
  327.  
  328.        For example, to create a diskette image from your drive B:,
  329.        simply type:
  330.  
  331.          dxp b: my_image
  332.  
  333.        The file "my_image.exe" will be created when Disk eXPress
  334.        finsihes.
  335.  
  336.        To create the diskette from the self-extract file created above,
  337.        you type:
  338.  
  339.          my_image b:
  340.  
  341.        OR
  342.  
  343.          dxp my_image.exe b:
  344.  
  345.        Disk eXPress allows command switches to be specified anywhere on
  346.        the command line.  Spaces between command line switches are not
  347.        required.  By default, the file extension is ".EXE" regardless of
  348.        what user specifies.  When creating a pure diskette image with
  349.        the /i switch, user is free to choose the file extension.  For
  350.        consistency, the recommended file extension to use is ".DXP".
  351.  
  352.        For example, under OS/2 with HPFS drive, a pure diskette image
  353.        can be created as follows:
  354.  
  355.          dxp a: "This is diskette 3 of 5.DXP" /i
  356.  
  357.        To create the diskette from the image:
  358.  
  359.          dxp "This is diskette 3 of 5.DXP" a: /f /v
  360.  
  361.        The /f switch tells Disk eXPress to format the diskette a track
  362.        at a time just before each track write.
  363.  
  364.        The /v switch tells Disk eXPress to verify the diskette write
  365.        after the track is written.
  366.  
  367.  
  368.  
  369.                                                                        7
  370.  
  371.  
  372.  
  373.        Note: When using quotes for HPFS filenames, make sure the quotes
  374.        are in front and after if you are specifying a full path:
  375.  
  376.        INCORRECT:
  377.  
  378.          dxp c:\"Disk Image 1.dxp" a:
  379.          c:\images\"Disk Image 2" a:
  380.  
  381.        CORRECT:
  382.  
  383.          dxp "c:\Disk Image 1.dxp" a:
  384.          "c:\images\Disk Image 2" a:
  385.  
  386.  
  387.        To QuickFormat a diskette in drive A:, type:
  388.  
  389.          dxp a: /q
  390.  
  391.        The /s switch may be used to bypass the QuickFormat warning
  392.        prompt.
  393.  
  394.  
  395.        You may stop Disk eXPress at any time by pressing Ctrl-C or Ctrl-
  396.        Break.  The BREAK ON/OFF setting under DOS is ignored.
  397.  
  398.        If Disk eXPress encounters any cluster marked as bad in the File
  399.        Allocation Table, you may receive a warning:
  400.  
  401.         X bad cluster(s) detected.
  402.         Bad clusters may not be reliably read by Disk eXPress!
  403.         However, if you do not encounter any 'Abort/Retry?'
  404.         message during read, the image should be fine.
  405.  
  406.        Note:
  407.        Disk eXPress will not detect bad clusters in advance if you by-
  408.        pass File Allocation Table (FAT) scanning by specifying the /a
  409.        switch.
  410.  
  411.        Disk eXPress or Xtract cannnot restore a diskette image onto a
  412.        diskette that contains physically bad sectors.
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.                                                                        8
  429.  
  430.  
  431.  
  432.        7.2. Disk eXPress help screens
  433.  
  434.        Type DXP at the OS/2 or DOS prompt to receive this help screen:
  435.  
  436.         Disk eXPress (OS/2 and DOS) Version 2.10a  02/12/93
  437.         Created by Albert J. Shan  Copyright (c) 1991-93  SHAREWARE VERSION
  438.  
  439.         Regular mode: DXP [options] [drive:] [d:][path]filename
  440.           [options]  /?    Display extract mode help screen
  441.                      /a    Read the entire disk (all sectors)
  442.                      /d    Input diskette image description (5 lines max.)
  443.                      /DOS  Output DOS only self-extract executable
  444.                      /i    Output just the diskette image
  445.                      /n    Disable data compression
  446.                      /s    Suppress overwrite prompt and self-check message
  447.                     drive  Drive letter of a valid diskette drive
  448.                  filename  Name of output file
  449.  
  450.         Valid options with only filename specified:
  451.                      /d    Display description in image file
  452.                      /e    Edit description in image file
  453.                      /r    Replace or add extract code to image file
  454.  
  455.         Note: Items enclosed in [] are optional.
  456.               Diskette must not contain any unreadable sectors.
  457.  
  458.         Supported formats: 160K, 180K, 320K, 360K, 1.2M, 720K,
  459.                            1.44M and 2.88M DOS diskettes.
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.                                                                        9
  488.  
  489.  
  490.  
  491.        Type DXP /?, and you'll get the help screen for the extract mode:
  492.  
  493.         Disk eXPress (OS/2 and DOS) Version 2.10a  02/12/93
  494.  
  495.         *** Type DXP by itself to see the regular mode help screen ***
  496.  
  497.         Extract mode: DXP [options] [d:][path]filename [drive:]
  498.           [options]  /t    Test image integrity only
  499.                      /d    Display description in image file
  500.                      /f    Format destination diskette
  501.                      /s    Suppress overwrite prompt and self-check message
  502.                      /v    Verify ON (system verify plus read and compare)
  503.                      /c    Convert image onto a higher density diskette
  504.                            (Target diskette must be pre-formatted, and
  505.                             of different form factor.  It also overrides /f)
  506.                  filename  Name of input file
  507.                     drive  Drive letter of a valid floppy drive
  508.  
  509.         Valid option with only drive specified:
  510.                      /q    QuickFormat destination diskette
  511.  
  512.         Note: Items enclosed in [] are optional.
  513.               The target diskette must be free of defects (no bad sectors).
  514.  
  515.         Supported formats: 160K, 180K, 320K, 360K, 1.2M, 720K,
  516.                            1.44M and 2.88M DOS diskettes.
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.                                                                       10
  547.  
  548.  
  549.  
  550.        8.0. COMMAND LINE SWITCHES DESCRIPTION
  551.        _________________________________________________________________
  552.  
  553.        When Disk eXPress is used under regular mode for making diskette
  554.        images, the following switches are available:
  555.  
  556.  
  557.        8.1. Regular mode
  558.  
  559.        /a   By default, Disk eXPress reads up to the last allocated
  560.             sector, according to the information it finds in the File
  561.             Allocation Table (FAT) in order to reduce the size of the
  562.             image file.  However, if there is any deleted files at the
  563.             end of FAT that you may want to recover later, the default
  564.             action will prevent you from a successful file recovery.
  565.             Use /a to tell Disk eXPress to create an exact duplicate of
  566.             the original diskette by saving ALL disk sectors to the
  567.             image file.
  568.  
  569.        /d   Prompt user to input description for the diskette image.  A
  570.             maximum of 5 lines of 40 characters each can be stored.
  571.             Disk eXPress bypasses user input, and reads the description
  572.             from the environment variables DXPDESC1 to DXPDESC5, if
  573.             there is at least one defined.
  574.  
  575.        /DOS By default, Disk eXPress creates self-extract images that
  576.             can be run under OS/2 and DOS.  By specifying this switch, a
  577.             DOS only self-extract image is created.  The DOS code has
  578.             been written so that it will run under OS/2 DOS box with
  579.             almost no speed penality.  This cuts self-extract code
  580.             overhead by about 13K.
  581.  
  582.        /i   Create a pure diskette image file.  The self-extract code
  583.             will not be bundled with the resulting file.  Disk eXPress
  584.             does not enforce any file extension for pure diskette image.
  585.             For consistency, it is recommended to use ".DXP" as file
  586.             extension.  Without specifying this switch, the default file
  587.             extension will be ".EXE".
  588.  
  589.        /n   Disable compression.  If the contents of the diskette is
  590.             highly compressed, Disk eXPress may not succeed in
  591.             compressing the data any further.  This can be visually
  592.             inspected when Disk eXPress is run the first time without
  593.             the /n switch.  If the real-time compression rate is very
  594.             low (close to 0%), disabling compression is recommended.
  595.  
  596.        /s   Disable any overwrite (y/N) prompt and Disk eXPress self-
  597.             check messages.
  598.  
  599.        Three switches are available when no drive letter is specified in
  600.        regular mode:
  601.  
  602.  
  603.  
  604.  
  605.                                                                       11
  606.  
  607.  
  608.  
  609.        /d   Display the description of the image file.  The full path to
  610.             the diskette image must be specified.
  611.  
  612.        /e   Edit the description stored in an image file.  This is used
  613.             to correct the description later instead of having to redo
  614.             the entire image from scratch.
  615.  
  616.        /r   Replace or add extract code to image file.  Full path and
  617.             complete filename must be specified.  If /r is used against
  618.             a self-extract diskette image, the self-extract code will be
  619.             replaced with the one stored with Disk eXPress.  No backup
  620.             file is created if the operation is successful.  If used
  621.             against a pure image file, the self-extract code will be
  622.             added, and a new file with ".EXE" extension will be created.
  623.             The ".EXE" file created by this switch is stored in the same
  624.             location of the original image file.  The /DOS and /s switch
  625.             can be used together with this switch.
  626.  
  627.             Note: The file extension replacement algorithm simply
  628.             removes any file extension starting after the last '.' and
  629.             then appending "EXE".  Since it is possible to use multiple
  630.             '.' under HPFS, the text after the last '.' is discarded.
  631.             It is advisable to avoid using multiple '.' with HPFS
  632.             filename, and use a space instead.
  633.  
  634.  
  635.        8.2. Extract mode
  636.  
  637.        Disk eXPress can decode and extract 3 types of images: type 0
  638.        (non-compressed), type 1 (Version 1 compression), and type 2
  639.        (Version 2 compression).  When Disk eXPress is used for
  640.        extracting an image file, the image file can be a pure image
  641.        file, or a self-extracting executable.  The full path to the
  642.        image file must be specified.  Wild cards are not allowed.  All
  643.        the switches available in the extract mode of Disk eXPress are
  644.        identical to the standalone Xtract program.
  645.  
  646.        /t   Test the integrity of the image only.  Disk eXPress performs
  647.             data decompression (if necessary) and runs through a 32-bit
  648.             CRC computation on the data stored in the image.  It reports
  649.             the stored and computed CRC values.  If these values do not
  650.             match, the image will be bad.  It overrides the
  651.             specification of a drive letter, /f, /s, /v, and the /c
  652.             switch.
  653.  
  654.        /d   Display the description of the image file.  The full path to
  655.             the diskette image must be specified.
  656.  
  657.        /f   Format the destination diskette.  Only standard DOS formats
  658.             are supported.
  659.  
  660.        /s   Disable any overwrite (y/N) prompt and Disk eXPress self-
  661.             check messages.
  662.  
  663.  
  664.                                                                       12
  665.  
  666.  
  667.  
  668.  
  669.        /v   Verify on.  It performs a track verify via operating system
  670.             call, follows by a track read, and a byte-by-byte comparison
  671.             with the original data.  The byte-by-byte comparison is
  672.             added as an extra protection should the CRC test of track
  673.             verify failed to pick up an error.  If disk cache is used
  674.             under DOS, the byte comparison test may not be valid due to
  675.             the fact that the cache is supplying the data with no actual
  676.             read performed on the diskette.  Disk eXPress bypasses disk
  677.             cache when it is run under OS/2.
  678.  
  679.        /c   Convert the image onto a higher density diskette.  The
  680.             target diskette must be of different form factor (3.5" to
  681.             5.25" and vice versa, but not 3.5" 720K to 3.5" 1.44M due to
  682.             hardware limitations).  It requires a formatted diskette,
  683.             and will automatically overrides the /f switch.
  684.  
  685.             Here is a list of all the diskette conversion possibilities:
  686.  
  687.               160K/180K/320K/360K to 720K/1.44M/2.88M
  688.                              720K to 1.2M
  689.                              1.2M to 1.44M/2.88M
  690.  
  691.        /q   QuickFormat of diskette in drive.  This is useful for
  692.             quickly erasing all files on an already formatted diskette.
  693.             The File Allocation Table (FAT) and all directory entries
  694.             are erased to zero.  Bad sectors and volume serial are
  695.             preserved after QuickFormatting.
  696.  
  697.  
  698.        8.3. Batch mode support
  699.  
  700.        You can use Disk eXPress, Xtract, and self-extract images in a
  701.        batch file (.CMD file under OS/2 and .BAT file under DOS).  The
  702.        return code returned by these programs are currently limited to
  703.        either a 0 or 1.  A return code of 0 indicates operation is
  704.        successful.  All display output is sent to standard out (stdout),
  705.        and can be redirected to a file.  Errors and warning messages are
  706.        sent to standard error (stderr).  You can discard all Disk
  707.        eXPress output by redirecting both stdout and stderr to NUL (ie:
  708.        DXP A: MyDisk >& NUL).
  709.  
  710.        In addition to entering diskette image description via the /d
  711.        switch, you can also enter the description from within a batch
  712.        file as shown below:
  713.  
  714.        SET DXPDESC1=Disk eXPress
  715.        SET DXPDESC2=Version 2.10a
  716.        SET DXPDESC4=Copyright (c) 1991-93
  717.        dxp a: MyDisk /d
  718.        SET DXPDESC1=
  719.        SET DXPDESC2=
  720.        SET DXPDESC4=
  721.  
  722.  
  723.                                                                       13
  724.  
  725.  
  726.  
  727.  
  728.        Line 3 and 5 are treated as blanks since DXPDESC3 and DXPDESC5
  729.        are not specified.  Batch mode description editing (/e) is also
  730.        supported.
  731.  
  732.  
  733.        8.4. Disk eXPress real-time bar graph display
  734.  
  735.        One of the new features of Disk eXPress Version 2 is the use of a
  736.        real-time bar graph display.  Disk eXPress and Xtract will
  737.        exercise the multi-threading capability under OS/2, and you'll
  738.        see a display similar to the following:
  739.  
  740.                                    3%      25%       50%       75%      100%
  741.             Action Rate Track Head ├────────┼─────────┼─────────┼─────────┤
  742.           COMPRESS  52%   37    1  █████████████████▓▓▓▓▓▓▓▓▓▒▒▒▒▒▒▒▒▒▒▒
  743.  
  744.        The above bar graph depicts 3 concurrent threads:
  745.  
  746.           ▒ Read thread.  Performs continuous reading of diskette (or
  747.             disk file if it is in extract mode), and releases the
  748.             diskette drive (or disk file) for use by another process
  749.             when reading is finished.
  750.           ▓ Compression/decompression thread.  Compression/decompression
  751.             is performed as soon as data is available from the read
  752.             thread.
  753.           █ Write thread.  Compressed data is written to a disk file (or
  754.             decompressed data written to diskette in extract mode).
  755.             This can be another diskette drive or any block device.
  756.  
  757.        The description under "Action" shows which thread has just
  758.        started executing.
  759.  
  760.        The number under "Rate" shows the current compression rate.  It
  761.        is the percentage reduction with respect to the size of the
  762.        original data.
  763.  
  764.        The numbers under "Track" and "Head" show the current disk track
  765.        and head where operation is being performed.
  766.  
  767.        Since DOS has only one thread of execution, only one bar is
  768.        updated at any time.  Read/Compress/Decompress/Write occurs
  769.        sequentially.
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.  
  781.  
  782.                                                                       14
  783.  
  784.  
  785.  
  786.        9.0. EXAMPLES
  787.        _________________________________________________________________
  788.  
  789.        9.1. Example 1
  790.  
  791.        To pack a 360K diskette in drive B: onto a file called 'disk1'
  792.        for modem transmission, you type:
  793.  
  794.            dxp b: e:\upload\disk1
  795.  
  796.        By default, Disk eXPress will automatically append ".EXE" onto
  797.        the output file name.  If you specify something else as file
  798.        extension, it will be removed before appending.  If the command
  799.        line syntax is correct, Disk eXPress will first run a self-check
  800.        for virus/modification, then it will proceed to create the
  801.        diskette image.  You'll receive a screen similar to the following
  802.        after Disk eXPress is finished:
  803.  
  804.           Checking Disk eXPress for modifications ... OK.
  805.  
  806.           360K diskette found in drive B:
  807.  
  808.           File Allocation Table statistics:
  809.           Track 33 head 1 contains the last allocated sector, sector 609.
  810.  
  811.                                    3%      25%       50%       75%      100%
  812.             Action Rate Track Head ├────────┼─────────┼─────────┼─────────┤
  813.              STORE  28%   33    1  ████████████████████████████████████████
  814.  
  815.           32-bit CRC of diskette image is DB49A615
  816.  
  817.        By default, Disk eXPress will analyze the FAT and save up to the
  818.        last sector used on the diskette.  In the above example, it stops
  819.        at track 33, head 1, because sector 609 is the last allocated
  820.        sector.  If you have a fragmented diskette, you might receive a
  821.        screen similar to the following when you run Disk eXPress:
  822.  
  823.           Checking Disk eXPress for modifications ... OK.
  824.  
  825.           1.44M diskette found in drive A:
  826.  
  827.           File Allocation Table statistics:
  828.           Track 36 head 1 contains the last allocated sector, sector 1319.
  829.  
  830.           Disk fragmentation detected:
  831.           814 unallocated sectors will be saved in image
  832.           (61% of total used sectors).
  833.           The diskette requires compression for maximum storage efficiency.
  834.  
  835.                                    3%      25%       50%       75%      100%
  836.             Action Rate Track Head ├────────┼─────────┼─────────┼─────────┤
  837.           COMPRESS  48%   16    0  ██████▓▓▒▒▒▒▒▒▒
  838.  
  839.  
  840.  
  841.                                                                       15
  842.  
  843.  
  844.  
  845.        etc.
  846.  
  847.        Running a disk optimization utility on the diskette will help
  848.        packing files tightly together for maximum storage efficiency.
  849.        Alternatively, you can copy all the files to another freshly
  850.        formatted diskette so that the files are packed next to each
  851.        other.
  852.  
  853.  
  854.        9.2. Example 2
  855.  
  856.        To save the entire diskette from drive A: (including all the
  857.        unused sectors) onto the image with compression turned off, you
  858.        type:
  859.  
  860.            dxp /a /n a: e:\upload\disk1
  861.  
  862.        You will see this warning if the file exists:
  863.  
  864.           Checking Disk eXPress for modifications ... OK.
  865.  
  866.           E:\UPLOAD\DISK1.EXE exists, overwrite? (y/N):
  867.  
  868.        Default action is 'No' for pressing the 'Enter' key.  Type 'y'
  869.        then 'Enter' to overwrite.
  870.  
  871.        To suppress the warning, specify /s on the command line:
  872.  
  873.            dxp /a /n a: e:\upload\disk1 /s
  874.  
  875.        Notice that you can specify switches anywhere you want on the
  876.        command line, Disk eXPress will sort them out for you.
  877.  
  878.  
  879.        9.3. Example 3
  880.  
  881.        To enter a description when creating an image, you type:
  882.  
  883.            dxp b: test15 /s /d
  884.  
  885.        You'll see:
  886.  
  887.           Checking Disk eXPress for modifications ... OK.
  888.  
  889.           Please enter diskette description: (5 lines max.)
  890.             ┌────────────────────────────────────────┐
  891.           1:
  892.  
  893.        You're then prompted to enter a maximum of five lines of
  894.        description (40 characters for each line).  To enter a blank
  895.        line, just press Enter.
  896.  
  897.        To continue our example, type in the following:
  898.  
  899.  
  900.                                                                       16
  901.  
  902.  
  903.  
  904.  
  905.           Please enter diskette description: (5 lines max.)
  906.             ┌────────────────────────────────────────┐
  907.           1: Joe,
  908.           2: This is the latest beta release of Space
  909.           3: Commander.  Try it out without a joy
  910.           4: stick and let me know how it goes.
  911.           5:   Regards, John
  912.  
  913.           360K diskette found in drive B:
  914.  
  915.           File Allocation Table statistics:
  916.           Track 33 head 1 contains the last allocated sector, sector 609.
  917.  
  918.                                    3%      25%       50%       75%      100%
  919.             Action Rate Track Head ├────────┼─────────┼─────────┼─────────┤
  920.              STORE  28%   16    1  ███████████████████▓▓▒▒▒▒▒▒▒
  921.  
  922.        etc.
  923.  
  924.  
  925.        9.4. Example 4
  926.  
  927.        To change the description of the diskette image created in the
  928.        last example, type:
  929.  
  930.            dxp e:\upload\test15.exe /e
  931.  
  932.        The /e switch allows description in the image file to be edited.
  933.        Note: The /r switch (self-extract code replacement) can also be
  934.        specified together with the /e switch.
  935.  
  936.  
  937.        9.5. Example 5
  938.  
  939.        Now that you have the self-extract image, what are you going to
  940.        do with it?  Simply run it!  To unpack the disk image created in
  941.        example 3, type 'test15' to see the help screen:
  942.  
  943.           Disk eXPress Self-Extract Diskette Image (OS/2 and DOS)
  944.           Version 2.10a  02/12/93  Copyright (c) 1991-93
  945.  
  946.           Usage: TEST15 [/s] [/t] [drive:]
  947.  
  948.              /s  Suppress overwrite prompt
  949.              /t  Test image integrity only
  950.           drive  Drive letter of a valid floppy disk drive
  951.  
  952.           Note: The target diskette must be formatted and must not
  953.                 have any bad sectors.
  954.  
  955.        To finish our example, now type:
  956.  
  957.  
  958.  
  959.                                                                       17
  960.  
  961.  
  962.  
  963.            test15 b:
  964.  
  965.        You'll see:
  966.  
  967.           ┌────── Diskette Image Description ──────┐
  968.            Joe,
  969.            This is the latest beta release of Space
  970.            Commander.  Try it out without a joy
  971.            stick and let me know how it goes.
  972.              Regards, John
  973.           └────────────────────────────────────────┘
  974.           360K diskette image stored in file.
  975.  
  976.  
  977.           Diskette in drive B: is about to be overwritten
  978.           with new information.  Do you wish to continue? (y/N)
  979.  
  980.        Default action is 'No' for pressing the 'Enter' key.  Press 'y'
  981.        then 'Enter' to start diskette image extraction.  The /s switch
  982.        can be specified to bypass the prompt.
  983.  
  984.  
  985.        9.6. Example 6
  986.  
  987.        To test the integrity of the diskette image without writing out
  988.        to the diskette, simply type:
  989.  
  990.            test15 /t
  991.  
  992.        And you'll see:
  993.  
  994.           ┌────── Diskette Image Description ──────┐
  995.            Joe,
  996.            This is the latest beta release of Space
  997.            Commander.  Try it out without a joy
  998.            stick and let me know how it goes.
  999.              Regards, John
  1000.           └────────────────────────────────────────┘
  1001.           360K diskette image stored in file.
  1002.  
  1003.           100% Read
  1004.  
  1005.             32-bit CRC stored: DB49A615
  1006.           32-bit CRC computed: DB49A615
  1007.  
  1008.        Note: /t overrides drive letter specified on the command line.
  1009.  
  1010.  
  1011.        9.7. Example 7
  1012.  
  1013.        Now that Joe got the diskette image.  He doesn't have a 360K or
  1014.        1.2M drive (5.25" drive).  All he has is a 1.44M 3.5" drive.  He
  1015.        also happens to have a spare 720K (low-density) diskette he can
  1016.  
  1017.  
  1018.                                                                       18
  1019.  
  1020.  
  1021.  
  1022.        use.  What can he do?  He can use the /c switch in the extract
  1023.        mode of Disk eXPress or Xtract.  The /c switch can be used to
  1024.        convert the diskette image from 360K to 720K, and all the data
  1025.        will still be intact, and usable.  The diskette used for
  1026.        conversion must be pre-formatted.  So, Joe went ahead and
  1027.        formatted the diskette as a 720K diskette, and he types:
  1028.  
  1029.            dxp test15.exe a: /c
  1030.  
  1031.        And receives the following screen (answer y at the prompt):
  1032.  
  1033.         Checking Disk eXPress for modifications ... OK.
  1034.         Checking test15.EXE for modifications ... OK.
  1035.  
  1036.           360K diskette image (Disk eXPress type 2)
  1037.  
  1038.         Diskette in drive A: is about to be overwritten
  1039.         with new information.  Do you wish to continue? (y/N) y
  1040.  
  1041.           720K diskette found in drive A:
  1042.         Converting 360K image onto 720K diskette ...
  1043.  
  1044.                               3%      25%       50%       75%      100%
  1045.             Action Track Head ├────────┼─────────┼─────────┼─────────┤
  1046.         DECOMPRESS   20    0  █████████▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  1047.  
  1048.        etc.
  1049.  
  1050.  
  1051.        9.8. Example 8
  1052.  
  1053.        To QuickFormat a diskette, type:
  1054.  
  1055.          dxp a: /q
  1056.  
  1057.        OR
  1058.  
  1059.          xtract a: /q
  1060.  
  1061.        And you'll see:
  1062.  
  1063.        Drive A: is about to be QuickFormatted.
  1064.        Do you wish to continue? (y/N)
  1065.  
  1066.        The default action is 'No' for pressing the Enter key.  The /s
  1067.        switch can be used to bypass the warning prompt.
  1068.  
  1069.        Type 'y' and press Enter and you'll see:
  1070.  
  1071.        QuickFormatting 1.44M diskette ... Done.
  1072.  
  1073.  
  1074.  
  1075.  
  1076.  
  1077.                                                                       19
  1078.  
  1079.  
  1080.  
  1081.        10.0. ERROR MESSAGES
  1082.        _________________________________________________________________
  1083.  
  1084.        Disk eXPress incorporates 32-bit CRC checking for itself and the
  1085.        image it creates.  In the event of a virus infection or other
  1086.        means of modifications (such as errors in electronic
  1087.        transmissions), the program will abort, and the following message
  1088.        is displayed:
  1089.  
  1090.        *** File has been modified or not a valid image file.
  1091.  
  1092.        Here is a run down of major error messages produced by Disk
  1093.        eXPress, Xtract and self-extract images: (usually a beep followed
  1094.        by one of the following messages)
  1095.  
  1096.        - For bad or not properly formatted diskette during read, write,
  1097.          format or verify (no beep for any Abort, Retry messages):
  1098.  
  1099.          Read Error: Abort, Retry? (a/R):
  1100.  
  1101.          Write Error: Abort, Retry? (a/R):
  1102.  
  1103.          Write Error: Abort, Retry, Format once, Format all? (a/R/o/f):
  1104.  
  1105.          Format Error: Abort, Retry? (a/R):
  1106.  
  1107.          Verify Error: Abort, Retry? (a/R):
  1108.  
  1109.          *** Bad CRC.
  1110.  
  1111.          *** Sector not found.
  1112.  
  1113.          *** General failure reading drive X:
  1114.  
  1115.          *** Unknown media/inconsistent boot record.
  1116.  
  1117.        - When disk is full during image creation (output will be
  1118.          deleted):
  1119.  
  1120.          *** Error writing disk or disk full.
  1121.  
  1122.        - With a write protected diskette during diskette write:
  1123.  
  1124.          *** Diskette is write protected.
  1125.  
  1126.        - When replacing self-extract code in images with a lower
  1127.          revision level of Disk eXPress:
  1128.  
  1129.          *** Image was created by Disk eXPress x.xx
  1130.          which is of higher revision level.
  1131.  
  1132.        - When diskette drive is not ready:
  1133.  
  1134.  
  1135.  
  1136.                                                                       20
  1137.  
  1138.  
  1139.  
  1140.          *** Drive X: not ready.
  1141.  
  1142.        - When drive specified is not available or not a diskette drive:
  1143.  
  1144.          *** Invalid drive/path specified.
  1145.  
  1146.          *** Drive X: is not a floppy drive.
  1147.  
  1148.        - When attempting to replace a version 1 self-extract header with
  1149.          version 2 by the /r switch:
  1150.  
  1151.          *** filename is not a type 2 image.
  1152.  
  1153.        - When Disk eXPress or Xtract is asked to extract an unrecognized
  1154.          image file:
  1155.  
  1156.          *** Diskette image header corrupted!
  1157.  
  1158.        - When Disk eXPress or Xtract is asked to convert a diskette
  1159.          image to the same form factor diskette:
  1160.  
  1161.          *** Conversion not supported on target diskette.
  1162.  
  1163.        - Some error messages returned by Disk eXPress are displayed as:
  1164.  
  1165.          *** Error n, Drive X:
  1166.  
  1167.        In such event, please document the procedure on how to get to the
  1168.        above error, and contact me as soon as possible.
  1169.  
  1170.  
  1171.  
  1172.  
  1173.  
  1174.  
  1175.  
  1176.  
  1177.  
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183.  
  1184.  
  1185.  
  1186.  
  1187.  
  1188.  
  1189.  
  1190.  
  1191.  
  1192.  
  1193.  
  1194.  
  1195.                                                                       21
  1196.  
  1197.  
  1198.  
  1199.        11.0. LIMITATIONS
  1200.        _________________________________________________________________
  1201.  
  1202.        Diskette images created by Disk eXPress version 2 are not
  1203.        compatible with version 1 images.  Replacement of version 1 self-
  1204.        extracting code with the /r switch is not allowed.
  1205.  
  1206.        When Disk eXPress is used to create a self-extract diskette
  1207.        image, the extract code is bundled as an overhead for each image
  1208.        created.  The overhead is currently at 24K (10.4K for DOS only
  1209.        image).  This is acceptable, considering the size of any non-
  1210.        trivial diskette image is usually quite large (in the order of
  1211.        several hundred kilo bytes or even mega bytes).  24K should
  1212.        require no more than two minutes for a 2400 baud modem to
  1213.        transfer, and with a 14.4K V.32bis modem, the overhead is less
  1214.        than 16 seconds.
  1215.  
  1216.        Other limitations include the inability to read a diskette drive
  1217.        over the LAN (limitation of the network driver), and Disk eXPress
  1218.        over any copy protected programs.  Another limitation is its
  1219.        inability to read over physically bad sectors.
  1220.  
  1221.        Any suggestions and comments are welcome.  Suggestions for new
  1222.        features may eventually be incorporated into a future release.
  1223.        Currently on the drawing board includes a 32-bit version for OS/2
  1224.        2.0, and the possibility of making it into a multi-threaded PM
  1225.        application with the use of System Object Model (SOM).
  1226.  
  1227.  
  1228.  
  1229.  
  1230.  
  1231.  
  1232.  
  1233.  
  1234.  
  1235.  
  1236.  
  1237.  
  1238.  
  1239.  
  1240.  
  1241.  
  1242.  
  1243.  
  1244.  
  1245.  
  1246.  
  1247.  
  1248.  
  1249.  
  1250.  
  1251.  
  1252.  
  1253.  
  1254.                                                                       22
  1255.